Skip to main content
Feedback

API Service profiles tab

The API Service Profiles tab enables you to review JSON and XML profiles referenced in API endpoint definitions and resolve profile type conflicts.

API Profiles tab containing sample profile information.

Objects list

The system categorizes objects by profile type (JSON or XML). It additionally categorizes objects with XML profiles by namespace. Selecting an object populates the usage list to the right.

In the tree structure:

  • Profile type node. represents a profile type node.

  • XML namespace node. represents an XML namespace node.

  • Profile type conflict does not exist. represents an object for which a profile type conflict does not exist.

  • Profile type conflict exists. represents an object for which a profile type conflict exists. The object name appears highlighted in red.

Usage list

For the selected object, the tab lists the profiles referenced in endpoint definitions. For each listed profile, it also shows how the endpoint definitions reference it, as follows:

  • type of usage — INPUT or OUTPUT

  • resource name and route URL (REST endpoints)

  • operation name (SOAP endpoints)

For usage shown in black type, the profile is configured as an override. For usage shown in gray type, the profile is the default derived from the linked process.

An API Service component should not be deployed if it specifies objects for which a profile type conflict exists. A profile type conflict exists if multiple referenced XML profiles include the same type and namespace or if multiple referenced JSON profiles have the same root name. You can resolve a conflict by standardizing on one profile:

Name
Description

Standardize on this profile
Initiates a request to resolve a profile type conflict. In the confirmation dialog:

  • Click OK and then Save to update the endpoint definitions.

  • Click Cancel to cancel the request.

On this Page